home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XSetWMProperties.z / XSetWMProperties
Encoding:
Text File  |  2002-10-03  |  12.5 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSeeeettttWWWWMMMMPPPPrrrrooooppppeeeerrrrttttiiiieeeessss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttWWWWMMMMPPPPrrrrooooppppeeeerrrrttttiiiieeeessss((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSetWMProperties, XmbSetWMProperties - set standard window
  10.           properties
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           void XSetWMProperties(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w__n_a_m_e, _i_c_o_n__n_a_m_e,
  14.           _a_r_g_v, _a_r_g_c, _n_o_r_m_a_l__h_i_n_t_s, _w_m__h_i_n_t_s, _c_l_a_s_s__h_i_n_t_s)
  15.                 Display *_d_i_s_p_l_a_y;
  16.                 Window _w;
  17.                 XTextProperty *_w_i_n_d_o_w__n_a_m_e;
  18.                 XTextProperty *_i_c_o_n__n_a_m_e;
  19.                 char **_a_r_g_v;
  20.                 int _a_r_g_c;
  21.                 XSizeHints *_n_o_r_m_a_l__h_i_n_t_s;
  22.                 XWMHints *_w_m__h_i_n_t_s;
  23.                 XClassHint *_c_l_a_s_s__h_i_n_t_s;
  24.  
  25.           void XmbSetWMProperties(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w__n_a_m_e, _i_c_o_n__n_a_m_e,
  26.           _a_r_g_v, _a_r_g_c,
  27.                                 _n_o_r_m_a_l__h_i_n_t_s, _w_m__h_i_n_t_s, _c_l_a_s_s__h_i_n_t_s)
  28.                 Display *_d_i_s_p_l_a_y;
  29.                 Window _w;
  30.                 char *_w_i_n_d_o_w__n_a_m_e;
  31.                 char *_i_c_o_n__n_a_m_e;
  32.                 char *_a_r_g_v[];
  33.                 int _a_r_g_c;
  34.                 XSizeHints *_n_o_r_m_a_l__h_i_n_t_s;
  35.                 XWMHints *_w_m__h_i_n_t_s;
  36.                 XClassHint *_c_l_a_s_s__h_i_n_t_s;
  37.  
  38.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  39.           _a_r_g_c      Specifies the number of arguments.
  40.  
  41.           _a_r_g_v      Specifies the application's argument list.
  42.  
  43.           _c_l_a_s_s__h_i_n_t_s
  44.                     Specifies the _X_C_l_a_s_s_H_i_n_t structure to be used.
  45.  
  46.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  47.  
  48.           _i_c_o_n__n_a_m_e Specifies the icon name, which should be a null-
  49.                     terminated string.
  50.  
  51.           _n_o_r_m_a_l__h_i_n_t_s
  52.                     Specifies the size hints for the window in its
  53.                     normal state.
  54.  
  55.           _w         Specifies the window.
  56.  
  57.           _w_i_n_d_o_w__n_a_m_e
  58.                     Specifies the window name, which should be a
  59.                     null-terminated string.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSeeeettttWWWWMMMMPPPPrrrrooooppppeeeerrrrttttiiiieeeessss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttWWWWMMMMPPPPrrrrooooppppeeeerrrrttttiiiieeeessss((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           _w_m__h_i_n_t_s  Specifies the _X_W_M_H_i_n_t_s structure to be used.
  75.  
  76.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  77.           The _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s convenience function provides a single
  78.           programming interface for setting those essential window
  79.           properties that are used for communicating with other
  80.           clients (particularly window and session managers).
  81.  
  82.           If the window_name argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
  83.           calls _X_S_e_t_W_M_N_a_m_e, which in turn, sets the WM_NAME property
  84.           (see section 14.1.4).  If the icon_name argument is non-
  85.           NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_I_c_o_n_N_a_m_e, which sets the
  86.           WM_ICON_NAME property (see section 14.1.5).  If the argv
  87.           argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_C_o_m_m_a_n_d,
  88.           which sets the WM_COMMAND property (see section 14.2.1).
  89.           Note that an argc of zero is allowed to indicate a zero-
  90.           length command.  Note also that the hostname of this machine
  91.           is stored using _X_S_e_t_W_M_C_l_i_e_n_t_M_a_c_h_i_n_e (see section 14.2.2).
  92.  
  93.           If the normal_hints argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
  94.           calls _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s, which sets the WM_NORMAL_HINTS
  95.           property (see section 14.1.7).  If the wm_hints argument is
  96.           non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_H_i_n_t_s, which sets the
  97.           WM_HINTS property (see section 14.1.6).
  98.  
  99.           If the class_hints argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
  100.           calls _X_S_e_t_C_l_a_s_s_H_i_n_t, which sets the WM_CLASS property (see
  101.           section 14.1.8).  If the res_name member in the _X_C_l_a_s_s_H_i_n_t
  102.           structure is set to the NULL pointer and the RESOURCE_NAME
  103.           environment variable is set, then the value of the
  104.           environment variable is substituted for res_name.  If the
  105.           res_name member is NULL, the environment variable is not
  106.           set, and argv and argv[0] are set, then the value of
  107.           argv[0], stripped of any directory prefixes, is substituted
  108.           for res_name.
  109.  
  110.           The _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s convenience function provides a
  111.           simple programming interface for setting those essential
  112.           window properties that are used for communicating with other
  113.           clients (particularly window and session managers).
  114.  
  115.           If the window_name argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
  116.           sets the WM_NAME property.  If the icon_name argument is
  117.           non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s sets the WM_ICON_NAME property.
  118.           The window_name and icon_name arguments are null-terminated
  119.           strings in the encoding of the current locale.  If the
  120.           arguments can be fully converted to the STRING encoding, the
  121.           properties are created with type ``STRING''; otherwise, the
  122.           arguments are converted to Compound Text, and the properties
  123.           are created with type ``COMPOUND_TEXT''.
  124.  
  125.           If the normal_hints argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXSSSSeeeettttWWWWMMMMPPPPrrrrooooppppeeeerrrrttttiiiieeeessss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttWWWWMMMMPPPPrrrrooooppppeeeerrrrttttiiiieeeessss((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           calls _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s, which sets the WM_NORMAL_HINTS
  141.           property (see section 14.1.7).  If the wm_hints argument is
  142.           non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_H_i_n_t_s, which sets
  143.           the WM_HINTS property (see section 14.1.6).
  144.  
  145.           If the argv argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s sets
  146.           the WM_COMMAND property from argv and argc.  An argc of zero
  147.           indicates a zero-length command.
  148.  
  149.           The hostname of the machine is stored using
  150.           _X_S_e_t_W_M_C_l_i_e_n_t_M_a_c_h_i_n_e (see section 14.2.2).
  151.  
  152.           If the class_hints argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
  153.           sets the WM_CLASS property.  If the res_name member in the
  154.           _X_C_l_a_s_s_H_i_n_t structure is set to the NULL pointer and the
  155.           RESOURCE_NAME environment variable is set, the value of the
  156.           environment variable is substituted for res_name.  If the
  157.           res_name member is NULL, the environment variable is not
  158.           set, and argv and argv[0] are set, then the value of
  159.           argv[0], stripped of any directory prefixes, is substituted
  160.           for res_name.
  161.  
  162.           It is assumed that the supplied class_hints.res_name and
  163.           argv, the RESOURCE_NAME environment variable, and the
  164.           hostname of the machine are in the encoding of the locale
  165.           announced for the LC_CTYPE category (on POSIX-compliant
  166.           systems, the LC_CTYPE, else LANG environment variable).  The
  167.           corresponding WM_CLASS, WM_COMMAND, and WM_CLIENT_MACHINE
  168.           properties are typed according to the local host locale
  169.           announcer.  No encoding conversion is performed prior to
  170.           storage in the properties.
  171.  
  172.           For clients that need to process the property text in a
  173.           locale, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s sets the WM_LOCALE_NAME property
  174.           to be the name of the current locale.  The name is assumed
  175.           to be in the Host Portable Character Encoding and is
  176.           converted to STRING for storage in the property.
  177.  
  178.           _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s and _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s can generate
  179.           _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
  180.  
  181.      PPPPRRRROOOOPPPPEEEERRRRTTTTIIIIEEEESSSS
  182.           WM_CLASS  Set by application programs to allow window and
  183.                     session managers to obtain the application's
  184.                     resources from the resource database.
  185.  
  186.           WM_CLIENT_MACHINE
  187.                     The string name of the machine on which the client
  188.                     application is running.
  189.  
  190.           WM_COMMAND
  191.                     The command and arguments, null-separated, used to
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXSSSSeeeettttWWWWMMMMPPPPrrrrooooppppeeeerrrrttttiiiieeeessss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttWWWWMMMMPPPPrrrrooooppppeeeerrrrttttiiiieeeessss((((3333XXXX11111111))))
  203.  
  204.  
  205.  
  206.                     invoke the application.
  207.  
  208.           WM_HINTS  Additional hints set by the client for use by the
  209.                     window manager.  The C type of this property is
  210.                     _X_W_M_H_i_n_t_s.
  211.  
  212.           WM_ICON_NAME
  213.                     The name to be used in an icon.
  214.  
  215.           WM_NAME   The name of the application.
  216.  
  217.           WM_NORMAL_HINTS
  218.                     Size hints for a window in its normal state.  The
  219.                     C type of this property is _X_S_i_z_e_H_i_n_t_s.
  220.  
  221.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  222.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  223.                     resource or server memory.
  224.  
  225.           _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  226.                     defined Window.
  227.  
  228.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  229.           XAllocClassHint(3X11), XAllocIconSize(3X11),
  230.           XAllocSizeHints(3X11), XAllocWMHints(3X11),
  231.           XParseGeometry(3X11), XSetCommand(3X11),
  232.           XSetTransientForHint(3X11), XSetTextProperty(3X11),
  233.           XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11),
  234.           XSetWMIconName(3X11), XSetWMName(3X11),
  235.           XSetWMProtocols(3X11), XStringListToTextProperty(3X11),
  236.           XTextListToTextProperty(3X11)
  237.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 10/3/02)
  262.  
  263.  
  264.  
  265.